Functions
NQ_INT	ccAddMountA (const NQ_CHAR mountPoint, const NQ_CHAR remotePath, NQ_BOOL connect)

NQ_INT	ccAddMount (const NQ_WCHAR mountPoint, const NQ_WCHAR remotePath, NQ_BOOL connect)

NQ_INT	ccAddMountWithCredsA (const NQ_CHAR mountPoint, const NQ_CHAR remotePath, NQ_BOOL connect, const AMCredentialsA *userCredentials)

NQ_INT	ccAddMountWithCreds (const NQ_WCHAR mountPoint, const NQ_WCHAR remotePath, NQ_BOOL connect, const AMCredentials *userCredentials)

NQ_INT	ccRemoveMountA (const NQ_CHAR *mountPoint)

NQ_INT	ccRemoveMount (const NQ_WCHAR *mountPoint)

NQ_GUID	ccGetServerIdA (const NQ_CHAR *mountpoint)

NQ_GUID	ccGetServerId (const NQ_WCHAR *mountpoint)

Detailed Description

Function Documentation

NQ_INT ccAddMountA	(	const NQ_CHAR *	mountPoint,
		const NQ_CHAR *	remotePath,
		NQ_BOOL	connect
	)

This function mounts the remote share as a local sub directory under the local virtual network file system.

Parameters

mountPoint	Local mount point for the share. The leading backslash is required. Example: \remoteShare1.
remotePath	Path to the remote share, starting from host name. Path syntax is \\<host>\<share>.
connect	A value of TRUE means that NQ will immediately connect to the remote share. Use FALSE to postpone connection to the first operation over this mount point.

Returns: This function returns 0 if the mount point was connected successfully or -1 otherwise. Application can examine the error code for the failure reason.

See Also: ccRemoveMount()

Note: This is an ASCII version of ccAddMount()

NQ_INT ccAddMount	(	const NQ_WCHAR *	mountPoint,
		const NQ_WCHAR *	remotePath,
		NQ_BOOL	connect
	)

This function mounts the remote share as a local sub directory under the local virtual network file system.

Parameters

mountPoint	Local mount point for the share. The leading backslash is required. Example: \remoteShare1.
remotePath	Path to the remote share, starting from host name. Path syntax is \\<host>\<share>.
connect	A value of TRUE means that NQ will immediately connect to the remote share. Use FALSE to postpone connection to the first operation over this mount point.

Returns: This function returns 0 if the mount point was connected successfully or -1 otherwise. Application can examine the error code for the failure reason.

See Also: ccRemoveMount()

NQ_INT ccAddMountWithCredsA	(	const NQ_CHAR *	mountPoint,
		const NQ_CHAR *	remotePath,
		NQ_BOOL	connect,
		const AMCredentialsA *	userCredentials
	)

This function mounts the remote share as a local sub directory under the local virtual network file system.

Parameters

mountPoint	Local mount point for the share. The leading backslash is required. Example: \remoteShare1.
remotePath	Path to the remote share, starting from host name. Path syntax is \\<host>\<share>.
connect	A value of TRUE means that NQ will immediately connect to the remote share. Use FALSE to postpone connection to the first operation over this mount point.
userCredentials	Pointer to a structure, which stores the user credentials. See AMCredentialsA structure in amapi.h file. If NULL is supplied anonymous credentials will be used. To initialize that structure use amCredentialsInitA() function from amcredentials file. In order to use anonymous credentials pass empty strings to amCredentialsInitA(): amCredentialsInitA(credentials, "", "", "", 0). In order to use anonymous credentials with password pass empty strings and password to amCredentialsInitA(): amCredentialsInitA(credentials, "", "", passwordString, 0). It is the caller responsibility to release that structure.

Returns: This function returns 0 if the mount point was connected successfully or -1 otherwise. Application can examine the error code for the failure reason.

See Also: ccRemoveMount()

Note: This is an ASCII version of ccAddMountWithCreds()

NQ_INT ccAddMountWithCreds	(	const NQ_WCHAR *	mountPoint,
		const NQ_WCHAR *	remotePath,
		NQ_BOOL	connect,
		const AMCredentials *	userCredentials
	)

This function mounts the remote share as a local sub directory under the local virtual network file system.

Parameters

mountPoint	Local mount point for the share. The leading backslash is required. Example: \remoteShare1.
remotePath	Path to the remote share, starting from host name. Path syntax is \\<host>\<share>.
connect	A value of TRUE means that NQ will immediately connect to the remote share. Use FALSE to postpone connection to the first operation over this mount point.
userCredentials	Pointer to a structure, which stores the user credentials. See AMCredentials structure in amapi.h file. If NULL is supplied anonymous credentials will be used. To initialize that structure use amCredentialsInitW() from amcredentials file. In order to use anonymous credentials pass empty strings to amCredentialsInitW(): amCredentialsInitW(credentials, emptyWideCharString, emptyWideCharString, emptyWideCharString, 0). In order to use anonymous credentials with password pass empty strings and password to amCredentialsInitW(): amCredentialsInitW(credentials, emptyWideCharString, emptyWideCharString, passwordString, 0). It is the caller responsibility to release that structure.

Returns: This function returns 0 if the mount point was connected successfully or -1 otherwise. Application can examine the error code for the failure reason.

See Also: ccRemoveMount()

NQ_INT ccRemoveMountA ( const NQ_CHAR * mountPoint )

This function makes mount point unavailable. It does not close the files opened over this mount point.

Parameters

mountPoint The name of the mount point to be removed.

Returns: This function returns 0 if the mount point has been successfully removed or -1 otherwise. Application can examine the error code for the failure reason.

See Also: ccAddMount()

Note: This is an ASCII version of ccRemoveMount()

NQ_INT ccRemoveMount ( const NQ_WCHAR * mountPoint )

This function makes mount point unavailable. It does not close the files opened over this mount point.

Parameters

mountPoint The name of the mount point to be removed.

Returns: This function returns 0 if the mount point has been successfully removed or -1 otherwise. Application can examine the error code for the failure reason.

See Also: ccAddMount()

NQ_GUID ccGetServerIdA ( const NQ_CHAR * mountpoint )

This function returns globally unique server identifier (GUID) associated with the given mount point.

Parameters

mountpoint The name of the mount point.

Returns: Globally unique server identifier 16 bytes long if available, zero identifier otherwise.

Note

Server GUID must not be used by a client as a secure method of identifying a server. Windows-based servers generate a new GUID each time they are started.
This is an ASCII version of ccGetServerId()

NQ_GUID ccGetServerId ( const NQ_WCHAR * mountpoint )

This function returns globally unique server identifier (GUID) associated with the given mount point.

Parameters

mountpoint The name of the mount point.

Returns: Globally unique server identifier 16 bytes long if available, zero identifier otherwise.

Note: Server GUID must not be used by a client as a secure method of identifying a server. Windows-based servers generate a new GUID each time they are started.

Functions

Detailed Description

Function Documentation